Skip to content

PR Template #1446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Aug 11, 2025
Merged

PR Template #1446

merged 3 commits into from
Aug 11, 2025

Conversation

jonahjung22
Copy link
Collaborator

@jonahjung22 jonahjung22 commented Aug 10, 2025 •
edited
Loading

Problem

The Jupyter AI repository currently does not have a PR template for PRs. Developers need a more streamlined template that focuses on the essential information while remaining comprehensive enough for proper code review. This addresses and fixes #1444.

Solution

Created a concise PR template that maintains the Problem/Solution structure while removing unnecessary sections. The new template:

  • Uses clear Problem/Solution sections for better narrative flow
  • Includes essential categorization with simple checkboxes
  • Focuses on testing instructions for reviewers
  • Maintains space for visual context when needed
  • Provides a minimal but complete checklist

Testing Instructions

Create a PR and fill out the template

Screenshots/Demo

Not Applicable

Future Enhancements

Not Applicable

@jonahjung22 jonahjung22 requested a review from andrii-i August 10, 2025 21:41
@jonahjung22 jonahjung22 self-assigned this Aug 10, 2025
@jonahjung22 jonahjung22 added the enhancement New feature or request label Aug 10, 2025
@jonahjung22 jonahjung22 linked an issue Aug 10, 2025 that may be closed by this pull request
Add PR template #1444
Closed
@krassowski
Copy link
Member

Personally I would find it useful for it to be more similar to templates used elsewhere in jupyter repos

@andrii-i
Copy link
Collaborator

Personally I would find it useful for it to be more similar to templates used elsewhere in jupyter repos

* https://github.com/jupyterlab/jupyterlab/blob/main/.github/pull_request_template.md

* https://github.com/jupyter-server/jupyter-scheduler/blob/main/.github/pull_request_template.md

Agreed, original issue for example references https://github.com/jupyter-server/jupyter-scheduler/blob/main/.github/pull_request_template.md.

andrii-i
andrii-i reviewed Aug 11, 2025
View reviewed changes
andrii-i
andrii-i reviewed Aug 11, 2025
View reviewed changes
andrii-i
andrii-i approved these changes Aug 11, 2025
View reviewed changes
Copy link
Collaborator

@andrii-i andrii-i left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thank you @jonahjung22.

dlqqq
dlqqq approved these changes Aug 11, 2025
View reviewed changes
Copy link
Member

@dlqqq dlqqq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, it's great to follow the Jupyter PR template. Thank you all for adding this.

I usually structure my PR descriptions differently, but this is a great starting point for new contributors. 👍

@jonahjung22 jonahjung22 merged commit c28a8f6 into jupyterlab:main Aug 11, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrii-i andrii-i andrii-i approved these changes

@dlqqq dlqqq dlqqq approved these changes

Assignees

@jonahjung22 jonahjung22

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add PR template
4 participants
@jonahjung22 @krassowski @andrii-i @dlqqq